Skip to content

[No QA] Update docs using Magic Code - #97278

Merged
zanyrenney merged 6 commits into
mainfrom
nikki-magic-helpdocs
Jul 30, 2026
Merged

zanyrenney merged 6 commits into
mainfrom
nikki-magic-helpdocs

Conversation

@NikkiWines

@NikkiWines NikkiWines commented Jul 28, 2026 •

Copy link
Copy Markdown
Contributor

cc: @laurenreidexpensify

Updates docs and a few stray comments to use security code or validateCode instead of magic code

Explanation of Change

Fixed Issues

$ #96180
PROPOSAL:

Tests

Verify the help docs linked in #97278 (comment) all use the term security code instead of magic code

  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Verify the help docs linked in #97278 (comment) all use the term security code instead of magic code

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

@NikkiWines NikkiWines self-assigned this Jul 28, 2026
@github-actions github-actions Bot changed the title Update docs using Magic Code [No QA] Update docs using Magic Code Jul 29, 2026
@OSBotify

This comment has been minimized.

@NikkiWines NikkiWines changed the title [No QA] Update docs using Magic Code [HOLD] Update docs using Magic Code Jul 29, 2026
@github-actions github-actions Bot changed the title [HOLD] Update docs using Magic Code [No QA] [HOLD] Update docs using Magic Code Jul 30, 2026
@OSBotify

This comment has been minimized.

@NikkiWines NikkiWines changed the title [No QA] [HOLD] Update docs using Magic Code Update docs using Magic Code Jul 30, 2026
@NikkiWines
NikkiWines marked this pull request as ready for review July 30, 2026 10:52
@NikkiWines
NikkiWines requested review from a team and stephanieelliott as code owners July 30, 2026 10:52
@github-actions github-actions Bot changed the title Update docs using Magic Code [No QA] Update docs using Magic Code Jul 30, 2026
@melvin-bot

melvin-bot Bot commented Jul 30, 2026 •

Copy link
Copy Markdown

Concierge reviewer checklist:

  • I have verified the accuracy of the article
    • The article is within a hub that makes sense, and the navigation is correct
    • All processes, screenshots, and examples align with current product behavior.
    • All links within the doc have been verified for correct destination and functionality.
  • I have verified the readability of the article
    • The article's language is clear, concise, and free of jargon.
    • The grammar, spelling, and punctuation are correct.
    • The article contains at least one image, or that an image is not necessary
  • I have verified the formatting of the article
    • The article has consistent formatting (headings, bullet points, etc.) with other HelpDot articles and that aligns with the HelpDot formatting standards.
    • The article has proper text spacing and breaks for readability.
  • I have verified the article has the appropriate tone and style
    • The article's tone is professional, friendly, and suitable for the target audience.
    • The article's tone, terminology, and voice are consistent throughout.
  • I have verified the overall quality of the article
    • The article is not missing any information, nor does it contain redundant information.
    • The article fully addresses user needs.
  • I have verified that all requested improvements have been addressed

For more detailed instructions on completing this checklist, see How do I review a HelpDot PR as a Concierge Team member?

cc @zanyrenney

@melvin-bot
melvin-bot Bot requested review from Pujan92 and zanyrenney July 30, 2026 10:52
@melvin-bot
melvin-bot Bot removed the request for review from a team July 30, 2026 10:52
@melvin-bot

melvin-bot Bot commented Jul 30, 2026

Copy link
Copy Markdown

@Pujan92 @zanyrenney One of you needs to copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

NOTE: It looks like docs/redirects.csv was modified in this PR. Please see this SO for special instructions on how to review changes to that file.

---

# Magic Code Login Emails
# Security Code Login Emails

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Heading structure violation: This is a second # (H1) heading in the article. Per HELP_AUTHORING_GUIDELINES.md Section 4, an article may have exactly one # heading (the title) plus an optional # FAQ — no other # headings. Demote this to ## Security Code login emails (and make it task-based, e.g. ## How Security Code login emails work).

# Security Code Login Emails

Magic Code emails are sent when you log in to Expensify and are critical for account access. These emails may be delayed or blocked due to spam filtering, corporate email policies, or server-level blocks. If you choose to or are automatically directed to sign in via SAML/SSO, you will **not** receive a magic code.
Security Code emails are sent when you log in to Expensify and are critical for account access. These emails may be delayed or blocked due to spam filtering, corporate email policies, or server-level blocks. If you choose to or are automatically directed to sign in via SAML/SSO, you will **not** receive a security code.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Terminology casing inconsistency: This line renames the term to "Security Code" but ends with lowercase "security code" ("you will not receive a security code"). Per HELPSITE_NAMING_CONVENTIONS.md, match capitalization exactly and be consistent. Capitalize as Security Code to match the rest of the diff.

- Scammers sometimes use urgent language like “Your account will be closed if you don’t respond.”

**Don’t click suspicious links, and never share your Magic Code in email. Expensify will only generate a magic code for you when you take an action in the app, such as logging in or making a high-risk change.**
**Don’t click suspicious links, and never share your Security Code in email. Expensify will only generate a security code for you when you take an action in the app, such as logging in or making a high-risk change.**

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Terminology casing inconsistency: This line uses lowercase "security code" ("Expensify will only generate a security code for you...") while the rest of the diff capitalizes it as Security Code. Per HELPSITE_NAMING_CONVENTIONS.md, match capitalization exactly and be consistent. Use Security Code.

## 3. Try Resending

- **Click "Resend Magic Code"** on the login screen
- **Click "Resend Security Code"** on the login screen

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Button naming violation: **Click "Resend Security Code"** wraps the button name in quotation marks. Per HELPSITE_NAMING_CONVENTIONS.md (Button Naming Standards), do not wrap button names in quotation marks — bold only. Use: Click Resend Security Code.

@github-actions

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR performs a global terminology migration, renaming Magic Code to Security Code across Expensify Classic Help articles, hidden stubs, and internal AgentZero references. It renames two files (Magic-Code-Access-Troubleshooting.md to Security-Code-Access-Troubleshooting.md and issues-receiving-the-magic-code.md to issues-receiving-the-security-code.md), updates all internal references, and correctly adds two 301 redirects in redirects.csv. The scope is a consistent find-and-replace: metadata (title, description, keywords, internalScope), body copy, FAQ entries, and cross-links were all updated. No new article structure was introduced.

Scores Summary

  • Readability: 8/10 - The changed lines remain clear, well-formed sentences and steps. No readability regressions were introduced by the swap. Minor deduction for a casing inconsistency (see below).
  • AI Readiness: 7/10 - Metadata blocks (keywords, description, internalScope) were updated in lockstep with body content, preserving search-intent alignment. Full feature name Security Code is used consistently in headings and keywords. The one renamed heading is noun/topic-only rather than task-based, but this is pre-existing structure carried over, not newly authored.
  • Style Compliance: 8/10 - Terminology is applied consistently and bold formatting on the term was preserved. Deduction for mixed casing between Security Code and lowercase security code on some changed lines, mirroring the old inconsistency rather than normalizing it.

Key Findings

  • Strong, disciplined migration: title, description, keywords, and internalScope were all updated together, so metadata stays aligned with the new terminology and real search intent.
  • Redirects were correctly added for both renamed files, and the cross-link in Two-Factor-Authentication.md was updated to the new path, so there are no dangling internal links.
  • Casing inconsistency introduced on several changed lines: most content uses title-case Security Code, but a few lines use lowercase security code (e.g. in Avoiding-common-scams.md, Email-Notifications.md, and the CONTRIBUTING/SKILL edits). Per the exact-UI and consistency rules, the term should be cased uniformly.
  • The changed top-level heading in Email-Notifications.md (Security Code Login Emails) is a noun-only, non-task-based secondary H1. This is a pre-existing structural issue not created by this PR, so it is not scored against the diff, but it is worth fixing in a follow-up since the line was already touched.

Recommendations

  • Normalize casing of the term throughout the diff. Decide whether the canonical form is Security Code (proper term) and apply it uniformly; avoid the lowercase security code variants introduced on some lines.
  • Confirm Security Code is the exact string shown in the product UI (login screen, resend button, verification prompts). The rule to match UI text exactly is the governing constraint here, including the Resend Security Code button label.
  • Optional follow-up (out of scope for this PR): the touched headings in Email-Notifications.md do not meet the single-H1 and task-based heading rules and could be restructured.

Files Reviewed

  • docs/articles/expensify-classic/settings/Avoiding-common-scams.md - Terminology and metadata updated; minor casing inconsistency.
  • docs/articles/expensify-classic/settings/Security-Code-Access-Troubleshooting.md (renamed) - Fully migrated; redirect added.
  • docs/articles/expensify-classic/settings/Email-Notifications.md - Migrated; pre-existing non-task headings noted.
  • docs/articles/expensify-classic/settings/Contact-Methods.md - Single-line term update, clean.
  • docs/articles/expensify-classic/settings/Merge-Accounts.md - Step text updated, clean.
  • docs/articles/expensify-classic/settings/General-product-troubleshooting.md - Link text and term updated, clean.
  • docs/articles/expensify-classic/settings/Two-Factor-Authentication.md - Cross-link path updated to renamed file, correct.
  • docs/articles/expensify-classic/getting-started/Create-a-Company-Workspace.md - Uses lowercase security code; casing note.
  • docs/articles/expensify-classic/getting-started/Create-a-workspace-for-yourself.md - Uses title-case Security Code, consistent.
  • docs/articles/Unlisted/Upcoming-Login-And-Security.md - Internal AgentZero reference updated correctly.
  • docs/Hidden/issues-receiving-the-security-code.md (renamed) - Stub migrated; redirect added.
  • docs/redirects.csv - Two correct 301 redirects added for renamed files.
  • contributingGuides/CONTRIBUTING.md and .claude/skills/playwright-app-testing/SKILL.md - Non-Help supporting edits; OTP wording is slightly awkward (security sign-in, Security code: Always 000000) but outside HelpDot governance scope.

Note: Detailed line-by-line feedback has been provided as inline comments.

@NikkiWines NikkiWines mentioned this pull request Jul 30, 2026
40 tasks done

@zanyrenney zanyrenney left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all good here, pretty simple ones!

@zanyrenney
zanyrenney merged commit bea8d2e into main Jul 30, 2026
26 of 28 checks passed
@zanyrenney
zanyrenney deleted the nikki-magic-helpdocs branch July 30, 2026 14:26
@melvin-bot melvin-bot Bot added the Emergency label Jul 30, 2026
@melvin-bot

melvin-bot Bot commented Jul 30, 2026

Copy link
Copy Markdown

@zanyrenney looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@OSBotify

Copy link
Copy Markdown
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify OSBotify mentioned this pull request Jul 31, 2026
67 tasks done
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/zanyrenney in version: 9.4.47-0 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

@OSBotify

OSBotify commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/marcaaron in version: 9.4.47-7 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

Bundle Size Analysis (Sentry):

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants